Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update generation to include header and link handler  #76

Merged
merged 2 commits into from
Sep 21, 2023

Conversation

dramich
Copy link
Contributor

@dramich dramich commented Sep 20, 2023

Remove the ###### Auto generated by spf13/cobra on 19-Sep-2023 which will cause problems with diffs later
Pull in cobra markdown gen and fixes a bug where
an extra line was being added to the end of the md files
causing pre-commit to fail in ci and update the files locally

spf13/cobra#2029

@dramich dramich requested review from coryodaniel and a team as code owners September 20, 2023 15:37
@dramich dramich force-pushed the genupdate  branch 3 times, most recently from 099db9b to 6bbee75 Compare September 20, 2023 17:43
This also pulls in cobra markdown gen and fixes a bug where
an extra line was being added to the end of the md files
causing pre-commit to fail in ci and update the files locally
Comment on lines +71 to +72
// Currently cobra has a bug where there is an extra line added to the end of the md file when
// the DisableAutoGenTag = true and this causes pre-commit to have to edit the file after generation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could also exclude the generated docs from end-of-file-fixer step in pre-commit.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered that but the file still has an extra line which may or may not cause issues later, so I up-streamed the fix and when/if it gets merged I will move back to upstream.

@dramich dramich merged commit 47fe9d9 into massdriver-cloud:main Sep 21, 2023
3 checks passed
@dramich dramich deleted the genupdate  branch September 21, 2023 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants